#pragma once
#ifndef CATA_SRC_MAGIC_H
#define CATA_SRC_MAGIC_H

#include <functional>
#include <map>
#include <optional>
#include <queue>
#include <set>
#include <string>
#include <string_view>
#include <unordered_set>
#include <utility>
#include <vector>

#include "body_part_set.h"
#include "bodypart.h"
#include "color.h"
#include "coordinates.h"
#include "damage.h"
#include "dialogue_helpers.h"
#include "enum_bitset.h"
#include "event_subscriber.h"
#include "magic_type.h"
#include "point.h"
#include "sounds.h"
#include "translation.h"
#include "type_id.h"
#include "uilist.h"

class Character;
class Creature;
class JsonObject;
class JsonOut;
class spell;
class time_duration;
struct const_dialogue;
struct dealt_projectile_attack;
struct requirement_data;

namespace spell_effect
{
struct override_parameters;
} // namespace spell_effect
template <typename E> struct enum_traits;

enum class spell_flag : int {
    PERMANENT, // items or creatures spawned with this spell do not disappear and die as normal
    PERMANENT_ALL_LEVELS, // items spawned with this spell do not disappear even if the spell is not max level
    PERCENTAGE_DAMAGE, //the spell deals damage based on the targets current hp.
    SPLIT_DAMAGE, // spell apply damage across all limbs. Works only with characters, for monsters do not have limbs
    IGNORE_WALLS, // spell's aoe goes through walls
    NO_PROJECTILE, // spell's original targeting area can be targeted through walls
    SWAP_POS, // a projectile spell swaps the positions of the caster and target
    HOSTILE_SUMMON, // summon spell always spawns a hostile monster
    HOSTILE_50, // summoned monster spawns friendly 50% of the time
    POLYMORPH_GROUP, // polymorph spell chooses a monster from a group
    FRIENDLY_POLY, // polymorph spell makes the monster friendly
    SILENT, // spell makes no noise at target
    NO_EXPLOSION_SFX, // spell has no visual explosion
    LOUD, // spell makes extra noise at target
    VERBAL, // spell makes noise at caster location, mouth encumbrance affects fail %
    SOMATIC, // arm encumbrance affects fail % and casting time (slightly)
    NO_HANDS, // hands do not affect spell energy cost
    UNSAFE_TELEPORT, // teleport spell risks killing the caster or others
    TARGET_TELEPORT, // aoe is teleport variance from target
    NO_LEGS, // legs do not affect casting time
    CONCENTRATE, // focus affects spell fail %
    RANDOM_AOE, // picks random number between min+increment*level and max instead of normal behavior
    RANDOM_DAMAGE, // picks random number between min+increment*level and max instead of normal behavior
    RANDOM_DURATION, // picks random number between min+increment*level and max instead of normal behavior
    RANDOM_TARGET, // picks a random valid target within your range instead of normal behavior.
    RANDOM_CRITTER, // same as RANDOM_TARGET but ignores ground
    MUTATE_TRAIT, // overrides the mutate spell_effect to use a specific trait_id instead of a category
    WONDER, // instead of casting each of the extra_spells, it picks N of them and casts them (where N is std::min( damage(), number_of_spells ))
    EXTRA_EFFECTS_FIRST, // the extra effects are cast before the main spell.
    PAIN_NORESIST, // pain altering spells can't be resisted (like with the deadened trait)
    NO_FAIL, // this spell cannot fail when you cast it
    SPAWN_GROUP, // spawn or summon from an item or monster group, instead of individual item/monster ID
    IGNITE_FLAMMABLE, // if spell effect area has any thing flammable, a fire will be produced
    MUST_HAVE_CLASS_TO_LEARN, // you can't learn the spell unless you already have the class.
    SPAWN_WITH_DEATH_DROPS, // allow summoned monsters to drop their usual death drops
    NO_CORPSE_QUIET, // allow summoned monsters to vanish/leave without leaving a corpse
    NON_MAGICAL, // ignores spell resistance
    PSIONIC, // psychic powers instead of traditional magic
    RECHARM, // charm_monster spell adds to duration of existing charm_monster effect
    CHARM_PET, // Applies the pet friendliness adjustment to a monster when charming them
    EVOCATION_SPELL, // Evocation spell category, used for Magiclysm proficiencies
    CHANNELING_SPELL, // Channeling spell category, used for Magiclysm proficiencies
    CONJURATION_SPELL, // Conjuration spell category, used for Magiclysm proficiencies
    ENHANCEMENT_SPELL, // Enhancement spell category, used for Magiclysm proficiencies
    ENERVATION_SPELL, // Enervation spell category, used for Magiclysm proficiencies
    CONVEYANCE_SPELL, // Conveyance spell category, used for Magiclysm proficiencies
    RESTORATION_SPELL, // Restoration spell category, used for Magiclysm proficiencies
    TRANSFORMATION_SPELL, // Transformation spell category, used for Magiclysm proficiencies
    LAST
};

enum class spell_target : int {
    ally,
    hostile,
    self,
    ground,
    none,
    item,
    field,
    vehicle,
    num_spell_targets
};

enum class spell_shape : int {
    // circular blast area
    blast,
    // hits anything in a line from the caster to the target with a width
    line,
    // aoe is radius of the arc
    cone,
    num_shapes
};

template<>
struct enum_traits<spell_shape> {
    static constexpr spell_shape last = spell_shape::num_shapes;
};

template<>
struct enum_traits<spell_target> {
    static constexpr spell_target last = spell_target::num_spell_targets;
};

template<>
struct enum_traits<spell_flag> {
    static constexpr spell_flag last = spell_flag::LAST;
};

struct fake_spell {
    spell_id id;

    static const std::optional<int> max_level_default;
    // max level this spell can be
    // if null pointer, spell can be up to its own max level
    std::optional<int> max_level;

    static const int level_default;
    // level for things that need it
    int level = level_default;

    static const bool self_default;
    // target tripoint is source (true) or target (false)
    bool self = self_default;

    static const int trigger_once_in_default;
    // a chance to trigger the enchantment spells
    int trigger_once_in = trigger_once_in_default;
    // a message when the enchantment is triggered
    translation trigger_message; // NOLINT(cata-serialize)
    // a message when the enchantment is triggered and is on npc
    translation npc_trigger_message; // NOLINT(cata-serialize)

    fake_spell() = default;
    explicit fake_spell( const spell_id &sp_id, bool hit_self = false,
                         const std::optional<int> &max_level = std::nullopt ) : id( sp_id ),
        max_level( max_level ), self( hit_self ) {}

    bool operator==( const fake_spell &rhs ) const {
        return id == rhs.id &&
               max_level == rhs.max_level &&
               level == rhs.level &&
               self == rhs.self &&
               trigger_once_in == rhs.trigger_once_in &&
               trigger_message == rhs.trigger_message &&
               npc_trigger_message == rhs.npc_trigger_message;
    }

    // gets the spell with an additional override for minimum level (default 0)
    spell get_spell( const Creature &caster, int min_level_override = 0 ) const;
    spell get_spell() const;

    bool is_valid() const;
    void load( const JsonObject &jo );
    void serialize( JsonOut &json ) const;
    void deserialize( const JsonObject &data );
};

class spell_events : public event_subscriber
{
    public:
        using event_subscriber::notify;
        void notify( const cata::event & ) override;
};

// NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
class spell_type
{
    public:

        spell_type() = default;

        bool was_loaded = false;

        spell_id id;
        // NOLINTNEXTLINE(cata-serialize)
        std::vector<std::pair<spell_id, mod_id>> src;
        mod_id src_mod;
        // spell name
        translation name;
        // spell description
        translation description;
        // spell message when cast
        translation message;
        // spell sound effect
        translation sound_description;
        skill_id skill;

        std::optional<magic_type_id> magic_type;

        requirement_id spell_components;

        sounds::sound_t sound_type = sounds::sound_t::LAST;
        bool sound_ambient = false;
        std::string sound_id;
        std::string sound_variant;
        // spell effect string. used to look up spell function
        std::string effect_name;
        bool teachable;
        // NOLINTNEXTLINE(cata-serialize)
        std::function<void( const spell &, Creature &, const tripoint_bub_ms & )> effect;
        std::function<std::set<tripoint_bub_ms>( const spell_effect::override_parameters &params,
                const tripoint_bub_ms &source, const tripoint_bub_ms &target )>
        spell_area_function; // NOLINT(cata-serialize)
        // the spell shape found in the json
        spell_shape spell_area = spell_shape::line;
        // extra information about spell effect. allows for combinations for effects
        std::string effect_str;
        // list of additional "spell effects"
        std::vector<fake_spell> additional_spells;

        // if the spell has a field name defined, this is where it is
        std::optional<field_type_id> field = std::nullopt;
        // the chance one_in( field_chance ) that the field spawns at a tripoint in the area of the spell
        dbl_or_var field_chance;
        // field intensity at spell level 0
        dbl_or_var min_field_intensity;
        // increment of field intensity per level
        dbl_or_var field_intensity_increment;
        // maximum field intensity allowed
        dbl_or_var max_field_intensity;
        // field intensity added to the map is +- ( 1 + field_intensity_variance ) * field_intensity
        dbl_or_var field_intensity_variance;

        // accuracy is a bonus against dodge, block, and spellcraft
        // which allows the target to mitigate up to 33% damage for each type of resistance
        // this could theoretically add up to 100%

        dbl_or_var min_accuracy;
        dbl_or_var accuracy_increment;
        dbl_or_var max_accuracy;

        // minimum damage this spell can cause
        dbl_or_var min_damage;
        // amount of damage increase per spell level
        dbl_or_var damage_increment;
        // maximum damage this spell can cause
        dbl_or_var max_damage;

        // minimum range of a spell
        dbl_or_var min_range;
        // amount of range increase per spell level
        dbl_or_var range_increment;
        // max range this spell can achieve
        dbl_or_var max_range;

        // minimum area of effect of a spell (radius)
        // 0 means the spell only affects the target
        dbl_or_var min_aoe;
        // amount of area of effect increase per spell level (radius)
        dbl_or_var aoe_increment;
        // max area of effect of a spell (radius)
        dbl_or_var max_aoe;

        // damage over time deals damage per turn

        // minimum damage over time
        dbl_or_var min_dot;
        // increment per spell level
        dbl_or_var dot_increment;
        // max damage over time
        dbl_or_var max_dot;

        // amount of time effect lasts

        // minimum time for effect in moves
        dbl_or_var min_duration;
        // increment per spell level in moves
        // DoT is per turn, but increments can be smaller
        dbl_or_var duration_increment;
        // max time for effect in moves
        dbl_or_var max_duration;

        // amount of damage that is piercing damage
        // not added to damage stat

        // minimum pierce damage
        dbl_or_var min_pierce;
        // increment of pierce damage per spell level
        dbl_or_var pierce_increment;
        // max pierce damage
        dbl_or_var max_pierce;

        dbl_or_var min_bash_scaling;
        dbl_or_var bash_scaling_increment;
        dbl_or_var max_bash_scaling;

        // base energy cost of spell
        dbl_or_var base_energy_cost;
        // increment of energy cost per spell level
        dbl_or_var energy_increment;
        // max or min energy cost, based on sign of energy_increment
        dbl_or_var final_energy_cost;

        // spell is restricted to being cast by only this class
        // if spell_class is empty, spell is unrestricted
        trait_id spell_class;

        // the difficulty of casting a spell
        dbl_or_var difficulty;

        // if projectile should shot more than one projectile
        dbl_or_var multiple_projectiles;

        // max level this spell can achieve
        dbl_or_var max_level;

        // base amount of time to cast the spell in moves
        dbl_or_var base_casting_time;
        // increment of casting time per level
        dbl_or_var casting_time_increment;
        // max or min casting time
        dbl_or_var final_casting_time;

        // Does leveling this spell lead to learning another spell?
        std::map<std::string, int> learn_spells;

        // what energy do you use to cast this spell
        magic_energy_type get_energy_source() const;

        // what energy do you use to cast this spell
        vitamin_id vitamin_energy_source() const;

        // if vitamin is used, specifies the color of an energy
        nc_color energy_color() const;

        damage_type_id dmg_type = damage_type_id::NULL_ID();

        // list of valid targets enum
        enum_bitset<spell_target> valid_targets;

        std::function<bool( const_dialogue const & )> condition; // NOLINT(cata-serialize)
        bool has_condition = false; // NOLINT(cata-serialize)

        translation condition_fail_message_; // NOLINT(cata-serialize)

        std::set<mtype_id> targeted_monster_ids;

        std::set<species_id> targeted_species_ids;

        std::set<species_id> ignored_species_ids;

        // list of bodyparts this spell applies its effect to
        body_part_set affected_bps;

        std::set<std::string> flags; // string flags

        // bitfield of -certain- string flags which are heavily checked
        enum_bitset<spell_flag> spell_tags; // NOLINT(cata-serialize)

        static void load_spell( const JsonObject &jo, const std::string &src );
        void load( const JsonObject &jo, std::string_view src );
        /**
         * All spells in the game.
         */
        static const std::vector<spell_type> &get_all();
        static void check_consistency();
        static void finalize_all();
        static void reset_all();
        bool is_valid() const;

        // these two formulas should be the inverse of eachother.  The spell xp will break if this is not the case.
        std::optional<jmath_func_id> overall_get_level_formula_id() const;
        std::optional<jmath_func_id> overall_exp_for_level_formula_id() const;

        // returns the exp required for the given level of the spell.
        int exp_for_level( int level ) const;
        // returns the level of this spell type if the spell has the given experience.
        int get_level( int experience ) const;
        // the maximum level of this spell that can be learned from a book.
        std::optional<int> get_max_book_level() const;
        // the base difficulty of the spell, unmodified by character specific spell adjustments
        int get_difficulty( const Creature &caster ) const;
    private:
        // default values
        static const skill_id skill_default;
        static const requirement_id spell_components_default;
        static const translation message_default;
        static const translation sound_description_default;
        static const sounds::sound_t sound_type_default;
        static const bool sound_ambient_default;
        static const std::string sound_id_default;
        static const std::string sound_variant_default;
        static const std::string effect_str_default;
        static const std::optional<field_type_id> field_default;
        static const int field_chance_default;
        static const int min_field_intensity_default;
        static const int max_field_intensity_default;
        static const float field_intensity_increment_default;
        static const float field_intensity_variance_default;
        static const int min_accuracy_default;
        static const float accuracy_increment_default;
        static const int max_accuracy_default;
        static const int min_damage_default;
        static const float damage_increment_default;
        static const int max_damage_default;
        static const int min_range_default;
        static const float range_increment_default;
        static const int max_range_default;
        static const int min_aoe_default;
        static const float aoe_increment_default;
        static const int max_aoe_default;
        static const int min_dot_default;
        static const float dot_increment_default;
        static const int max_dot_default;
        static const int min_duration_default;
        static const int duration_increment_default;
        static const int max_duration_default;
        static const int min_pierce_default;
        static const float pierce_increment_default;
        static const int max_pierce_default;
        static const float min_bash_scaling_default;
        static const float max_bash_scaling_default;
        static const float bash_scaling_increment_default;
        static const int base_energy_cost_default;
        static const float energy_increment_default;
        static const trait_id spell_class_default;
        static const magic_energy_type energy_source_default;
        static const damage_type_id dmg_type_default;
        static const int difficulty_default;
        static const int multiple_projectiles_default;
        static const int max_level_default;
        static const int base_casting_time_default;
        static const float casting_time_increment_default;

        std::optional<magic_energy_type> energy_source;
        std::optional<vitamin_id> vitamin_energy_source_; // NOLINT(cata-serialize)
        std::optional<nc_color> energy_color_; // NOLINT(cata-serialize)
        std::optional<jmath_func_id> get_level_formula_id;
        std::optional<jmath_func_id> exp_for_level_formula_id;
        std::optional<int> max_book_level;
};

class spell
{
    private:
        friend class spell_events;
        // basic spell data
        spell_id type;

        // once you accumulate enough exp you level the spell
        int experience = 0;
        // returns damage type for the spell
        const damage_type_id &dmg_type() const;

        // Temporary adjustments caused by EoC's
        int temp_level_adjustment = 0; // NOLINT(cata-serialize)
        float temp_damage_multiplyer = 1; // NOLINT(cata-serialize)
        float temp_cast_time_multiplyer = 1; // NOLINT(cata-serialize)
        float temp_spell_cost_multiplyer = 1; // NOLINT(cata-serialize)
        float temp_aoe_multiplyer = 1; // NOLINT(cata-serialize)
        float temp_range_multiplyer = 1; // NOLINT(cata-serialize)
        float temp_duration_multiplyer = 1; // NOLINT(cata-serialize)
        int temp_difficulty_adjustment = 0; // NOLINT(cata-serialize)
        float temp_somatic_difficulty_multiplyer = 1; // NOLINT(cata-serialize)
        float temp_sound_multiplyer = 1; // NOLINT(cata-serialize)
        float temp_concentration_difficulty_multiplyer = 1; // NOLINT(cata-serialize)


        // alternative cast message
        translation alt_message;

        // minimum damage including levels
        int min_leveled_damage( const Creature &caster ) const;
        double min_leveled_dot( const Creature &caster ) const;
        // minimum aoe including levels
        int min_leveled_aoe( const Creature &caster ) const;
        // minimum duration including levels (moves)
        int min_leveled_duration( const Creature &caster ) const;
        int min_leveled_accuracy( const Creature &caster ) const;

    public:
        spell() = default;
        explicit spell( spell_id sp, int xp = 0, int level_adjustment = 0 );

        // sets the message to be different than the spell_type specifies
        void set_message( const translation &msg );

        double bash_scaling( const Creature &caster ) const;

        int exp_for_level( int level ) const;
        // how much exp you need for the spell to gain a level
        int exp_to_next_level() const;
        // progress to the next level, expressed as a percent
        std::string exp_progress() const;
        // how much xp you have total
        int xp() const;
        // gain some exp
        void gain_exp( const Character &guy, int nxp );
        void set_exp( int nxp );
        // how much xp you get if you successfully cast the spell
        int casting_exp( const Character &guy ) const;
        // modifier for gaining exp
        float exp_modifier( const Character &guy ) const;
        // level up!
        void gain_level( const Character &guy );
        // gains a number of levels, or until max. 0 or less just returns early.
        void gain_levels( const Character &guy, int gains );
        void set_level( const Character &guy, int nlevel );
        // is the spell at max level?
        bool is_max_level( const Creature &caster ) const;
        // what is the max level of the spell
        int get_max_level( const Creature &caster ) const;
        int get_temp_level_adjustment() const;
        void set_temp_level_adjustment( int adjustment );
        void set_temp_adjustment( const std::string &target_property, float adjustment );
        void clear_temp_adjustments();

        spell_shape shape() const;
        // what is the intensity of the field the spell generates ( 0 if no field )
        int field_intensity( const Creature &caster ) const;
        // how much damage does the spell do
        int damage( const Creature &caster ) const;
        int accuracy( Creature &caster ) const;
        double damage_dot( const Creature &caster ) const;
        damage_over_time_data damage_over_time( const std::vector<bodypart_id> &bps,
                                                const Creature &caster ) const;
        dealt_damage_instance get_dealt_damage_instance( Creature &caster ) const;
        dealt_projectile_attack get_projectile_attack( const tripoint_bub_ms &target,
                Creature &hit_critter, Creature &caster ) const;
        damage_instance get_damage_instance( Creature &caster ) const;
        // calculate damage per second against a target
        float dps( const Character &caster, const Creature &target ) const;
        // select a target for the spell
        std::optional<tripoint_bub_ms> select_target( Creature *source );
        // how big is the spell's radius
        int aoe( const Creature &caster ) const;
        std::set<tripoint_bub_ms> effect_area( const spell_effect::override_parameters &params,
                                               const tripoint_bub_ms &source, const tripoint_bub_ms &target ) const;
        std::set<tripoint_bub_ms> effect_area( const tripoint_bub_ms &source, const tripoint_bub_ms &target,
                                               const Creature &caster ) const;
        // distance spell can be cast
        int range( const Creature &caster ) const;
        /**
         *  all of the tripoints the spell can be cast at.
         *  if the spell can't be cast through walls, does not return anything behind walls
         *  if the spell can't target the ground, can't target unseen locations, etc.
         */
        std::vector<tripoint_bub_ms> targetable_locations( const Character &source ) const;
        // how much energy does the spell cost
        int energy_cost( const Character &guy ) const;
        // how long does this spell's effect last
        int duration( const Creature &caster ) const;
        time_duration duration_turns( const Creature &caster ) const;
        // how often does the spell fail
        // based on difficulty, level of spell, spellcraft skill, intelligence
        float spell_fail( const Character &guy ) const;
        std::string colorized_fail_percent( const Character &guy ) const;
        // how long does it take to cast the spell
        int casting_time( const Character &guy, bool ignore_encumb = false ) const;
        // the requirement data for spell components. includes tools, items, and qualities.
        const requirement_data &components() const;
        bool has_components() const;
        // can the Character cast this spell?
        bool can_cast( const Character &guy ) const;
        bool can_cast( const Character &guy, std::map<magic_type_id, bool> &success_tracker );
        // can the Character learn this spell?
        bool can_learn( const Character &guy ) const;
        // if spell shoots more than one projectile
        int get_amount_of_projectiles( const Creature &guy ) const;
        // is this spell valid
        bool is_valid() const;
        int bps_affected() const;
        // is the bodypart affected by the effect
        bool bp_is_affected( const bodypart_id &bp ) const;
        // check if the spell has a particular flag
        bool has_flag( const spell_flag &flag ) const;
        bool has_flag( const std::string &flag ) const;
        bool no_hands() const;
        // check if the spell's class is the same as input
        bool is_spell_class( const trait_id &mid ) const;

        bool in_aoe( const tripoint_bub_ms &source, const tripoint_bub_ms &target,
                     const Creature &caster ) const;

        bool casting_time_encumbered( const Character &guy ) const;
        bool energy_cost_encumbered( const Character &guy ) const;
        std::string enumerate_spell_data( const Character &guy ) const;

        // get spell id (from type)
        spell_id id() const;
        // get spell class (from type)
        trait_id spell_class() const;
        // get skill id
        skill_id skill() const;
        // get spell effect string (from type)
        std::string effect() const;
        // get spell effect_str data
        std::string effect_data() const;
        // get spell summon vehicle id
        vproto_id summon_vehicle_id() const;
        // name of spell (translated)
        std::string name() const;
        // description of spell (translated)
        std::string description() const;
        // spell message when cast (translated)
        std::string message() const;
        // energy source as a string (translated)
        std::string energy_string() const;
        // energy cost returned as a string
        std::string energy_cost_string( const Character &guy ) const;
        // current energy the Character has available as a string
        std::string energy_cur_string( const Character &guy ) const;
        // prints out a list of valid targets separated by commas
        std::string enumerate_targets() const;
        // returns the name string of all list of all targeted monster id
        //if targeted_monster_ids is empty, it returns an empty string
        std::string list_targeted_monster_names() const;
        //if targeted_species_ids is empty, it returns an empty string
        std::string list_targeted_species_names() const;
        //if ignored_species_ids is empty, it returns an empty string
        std::string list_ignored_species_names() const;

        std::string damage_string( const Character &caster ) const;
        std::string aoe_string( const Creature &caster ) const;
        std::string duration_string( const Creature &caster ) const;

        // magic energy source enum
        magic_energy_type energy_source() const;
        std::optional<vitamin_id> vitamin_energy_source() const;
        nc_color energy_color() const;
        // the color that's representative of the damage type
        nc_color damage_type_color() const;
        std::string damage_type_string() const;
        // your level in this spell
        int get_level() const;
        // your level in this spell adjusted by context
        int get_effective_level() const;
        // difficulty of the level
        int get_difficulty( const Creature &caster ) const;
        mod_id get_src() const;

        std::optional<int> max_book_level() const;
        double get_failure_cost_percent( Creature &caster ) const;
        double get_failure_exp_percent( Creature &caster ) const;
        void consume_spell_cost( Character &caster, bool cast_success = true ) const;
        std::vector<effect_on_condition_id> get_failure_eoc_ids() const;

        // tries to create a field at the location specified
        void create_field( const tripoint_bub_ms &at, Creature &caster ) const;

        int sound_volume( const Creature &caster ) const;
        // makes a spell sound at the location
        void make_sound( const tripoint_bub_ms &target, Creature &caster ) const;
        void make_sound( const tripoint_bub_ms &target, int loudness ) const;
        // heals the critter at the location, returns amount healed (Character heals each body part)
        int heal( const tripoint_bub_ms &target, Creature &caster ) const;

        // casts the spell effect from an item.  less functionality compared to creature casting.
        void cast_spell_effect( const tripoint_bub_ms &target ) const;
        // casts the spell effect. returns true if successful
        void cast_spell_effect( Creature &source, const tripoint_bub_ms &target ) const;
        // goes through the spell effect and all of its internal spells
        void cast_all_effects( const tripoint_bub_ms &target ) const;
        // goes through the spell effect and all of its internal spells
        void cast_all_effects( Creature &source, const tripoint_bub_ms &target ) const;
        // goes through the spell effect and all of its internal spells
        void cast_extra_spell_effects( const tripoint_bub_ms &target ) const;
        // goes through the spell effect and all of its internal spells
        void cast_extra_spell_effects( Creature &source, const tripoint_bub_ms &target ) const;
        // uses up the components in @guy's inventory
        void use_components( Character &guy ) const;
        // checks if the spell's component is in the @guy's hand
        bool check_if_component_in_hand( Character &guy ) const;
        // checks if a target point is in spell range
        bool is_target_in_range( const Creature &caster, const tripoint_bub_ms &p ) const;

        // is the target valid for this spell?
        bool is_valid_target( const Creature &caster, const tripoint_bub_ms &p ) const;
        bool is_valid_target( spell_target t ) const;
        bool target_by_monster_id( const tripoint_bub_ms &p ) const;
        bool target_by_species_id( const tripoint_bub_ms &p ) const;
        bool ignore_by_species_id( const tripoint_bub_ms &p ) const;
        bool valid_by_condition( const Creature &caster, const Creature &target ) const;
        bool valid_by_condition( const Creature &caster ) const;

        std::string failed_condition_message() const;

        // picks a random valid tripoint from @area
        std::optional<tripoint_bub_ms> random_valid_target( const Creature &caster,
                const tripoint_bub_ms &caster_pos ) const;
};

class known_magic
{
    private:
        // list of spells known
        std::map<spell_id, spell> spellbook;
        // Map of spell_id to invlets.
        std::map<spell_id, int> spells_to_invlets;
        // Map of invlets to spell_id. Created from spells_to_invlets on load.
        std::map<int, spell_id> invlets_to_spells; // NOLINT(cata-serialize)
        // list of favorite spells
        std::unordered_set<spell_id> favorites;
        // the base mana a Character would start with
        int mana_base = 0; // NOLINT(cata-serialize)
        // current mana
        int mana = 0;

    public:
        // ignores all distractions when casting a spell when true
        bool casting_ignore = false; // NOLINT(cata-serialize)

        known_magic();

        void learn_spell( const std::string &sp, Character &guy, bool force = false );
        void learn_spell( const spell_id &sp, Character &guy, bool force = false );
        void learn_spell( const spell_type *sp, Character &guy, bool force = false );
        void forget_spell( const std::string &sp );
        void forget_spell( const spell_id &sp );
        void set_spell_level( const spell_id &, int, const Character * );
        void set_spell_exp( const spell_id &, int, const Character * );
        // time in moves for the Character to memorize the spell
        int time_to_learn_spell( const Character &guy, const spell_id &sp ) const;
        int time_to_learn_spell( const Character &guy, const std::string &str ) const;
        bool can_learn_spell( const Character &guy, const spell_id &sp, bool improved_spell = false ) const;
        bool knows_spell( const std::string &sp ) const;
        bool knows_spell( const spell_id &sp ) const;
        // does the Character know a spell?
        bool knows_spell() const;
        // spells known by Character
        std::vector<spell_id> spells() const;
        // gets the spell associated with the spell_id to be edited
        spell &get_spell( const spell_id &sp );
        // opens up a ui that the Character can choose a spell from
        // returns the selected spell
        spell &select_spell( Character &guy );
        // get all known spells
        std::vector<spell *> get_spells();
        // Last spell casted
        spell_id last_spell = spell_id::NULL_ID(); // NOLINT(cata-serialize)
        // directly get the character known spells
        std::map<spell_id, spell> &get_spellbook() {
            return spellbook;
        }
        // how much mana is available to use to cast spells
        int available_mana() const;
        // max mana available
        int max_mana( const Character &guy ) const;
        void mod_mana( const Character &guy, int add_mana );
        void set_mana( int new_mana );
        void update_mana( const Character &guy, float turns );
        // does the Character have enough energy to cast this spell?
        // not specific to mana
        bool has_enough_energy( const Character &guy, const spell &sp ) const;
        // Clears old data written by EoC triggered by the events player_opens_spellbook or npc_opens_spellbook
        void clear_opens_spellbook_data();
        // uses data received from EoC
        void evaluate_opens_spellbook_data();

        void on_mutation_gain( const trait_id &mid, Character &guy );
        void on_mutation_loss( const trait_id &mid, Character &guy );

        // data written by EoC
        double caster_level_adjustment; // NOLINT(cata-serialize)
        std::map<spell_id, double> caster_level_adjustment_by_spell; // NOLINT(cata-serialize)
        std::map<trait_id, double> caster_level_adjustment_by_school; // NOLINT(cata-serialize)

        void serialize( JsonOut &json ) const;
        void deserialize( const JsonObject &data );

        // gets invlet if assigned, or assigns first available letter if not.
        // Returns 0 if no letters available.
        int get_invlet( const spell_id &sp );
        // returns false if invlet is already used
        bool set_invlet( const spell_id &sp, int invlet );
        // swaps hotkeys of new_sp and spell currently using invlet.
        void swap_invlet( const spell_id &new_sp, int invlet );
        void rem_invlet( const spell_id &sp );

        void toggle_favorite( const spell_id &sp );
        bool is_favorite( const spell_id &sp );

        void migrate_spells();
    private:
        // gets length of longest spell name
        int get_spellname_max_width();
        // builds invlets_to_spells after loading a save.
        void build_invlets_to_spells();
};

namespace spell_effect
{
// a struct available for override parameters.
// is a separate struct for later extensibility
// used for spell shapes to be lighter weight than passing the whole spell
// and allows for overrides for these values
struct override_parameters {
    int aoe_radius;
    int range;
    bool ignore_walls;

    explicit override_parameters( const spell &sp, const Creature &caster ) {
        aoe_radius = sp.aoe( caster );
        range = sp.range( caster );
        ignore_walls = sp.has_flag( spell_flag::IGNORE_WALLS );
    }
};

void short_range_teleport( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void pain_split( const spell &, Creature &, const tripoint_bub_ms & );
void attack( const spell &sp, Creature &caster, const tripoint_bub_ms &epicenter );
void targeted_polymorph( const spell &sp, Creature &caster, const tripoint_bub_ms &target );

void area_pull( const spell &sp, Creature &caster, const tripoint_bub_ms &center );
void area_push( const spell &sp, Creature &caster, const tripoint_bub_ms &center );
void directed_push( const spell &sp, Creature &caster, const tripoint_bub_ms &target );

std::set<tripoint_bub_ms> spell_effect_blast( const override_parameters &params,
        const tripoint_bub_ms &, const tripoint_bub_ms &target );
std::set<tripoint_bub_ms> spell_effect_cone( const override_parameters &params,
        const tripoint_bub_ms &source, const tripoint_bub_ms &target );
std::set<tripoint_bub_ms> spell_effect_line( const override_parameters &params,
        const tripoint_bub_ms &source, const tripoint_bub_ms &target );

void spawn_ethereal_item( const spell &sp, Creature &, const tripoint_bub_ms & );
void recover_energy( const spell &sp, Creature &, const tripoint_bub_ms &target );
void spawn_summoned_monster( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void spawn_summoned_vehicle( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void recharge_vehicle( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void translocate( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
// adds a timed event to the caster only
void timed_event( const spell &sp, Creature &caster, const tripoint_bub_ms & );
void transform_blast( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void noise( const spell &sp, Creature &, const tripoint_bub_ms &target );
void vomit( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
// intended to be a spell version of Character::longpull
void pull_to_caster( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void explosion( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void flashbang( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void mod_moves( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void map( const spell &sp, Creature &caster, const tripoint_bub_ms & );
void morale( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void charm_monster( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void mutate( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void bash( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void dash( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void banishment( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
// revives a monster into some kind of zombie if the monster has the revives flag
void revive( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
// revives a dormant monster if it has the revives and the dormant flag
void revive_dormant( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void add_trap( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void upgrade( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
// causes guilt to the target as if it killed the caster
void guilt( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void remove_effect( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void emit( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void fungalize( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void remove_field( const spell &sp, Creature &caster, const tripoint_bub_ms &center );
void effect_on_condition( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void pickup( const spell &sp, Creature &caster, const tripoint_bub_ms &target );
void none( const spell &sp, Creature &, const tripoint_bub_ms &target );
void slime_split_on_death( const spell &sp, Creature &, const tripoint_bub_ms &target );

inline const std::map<spell_shape, std::function<std::set<tripoint_bub_ms>
( const override_parameters &, const tripoint_bub_ms &, const tripoint_bub_ms & )>> shape_map = {
    { spell_shape::blast, spell_effect_blast },
    { spell_shape::line, spell_effect_line },
    { spell_shape::cone, spell_effect_cone }
};

inline const
std::map<std::string, std::function<void( const spell &, Creature &, const tripoint_bub_ms & )>>
effect_map{
    { "pain_split", spell_effect::pain_split },
    { "attack", spell_effect::attack },
    { "add_trap", spell_effect::add_trap},
    { "targeted_polymorph", spell_effect::targeted_polymorph },
    { "short_range_teleport", spell_effect::short_range_teleport },
    { "spawn_item", spell_effect::spawn_ethereal_item },
    { "recover_energy", spell_effect::recover_energy },
    { "summon", spell_effect::spawn_summoned_monster },
    { "summon_vehicle", spell_effect::spawn_summoned_vehicle },
    { "recharge_vehicle", spell_effect::recharge_vehicle },
    { "translocate", spell_effect::translocate },
    { "area_pull", spell_effect::area_pull },
    { "area_push", spell_effect::area_push },
    { "directed_push", spell_effect::directed_push },
    { "timed_event", spell_effect::timed_event },
    { "ter_transform", spell_effect::transform_blast },
    { "noise", spell_effect::noise },
    { "vomit", spell_effect::vomit },
    { "pull_target", spell_effect::pull_to_caster },
    { "explosion", spell_effect::explosion },
    { "flashbang", spell_effect::flashbang },
    { "mod_moves", spell_effect::mod_moves },
    { "map", spell_effect::map },
    { "morale", spell_effect::morale },
    { "charm_monster", spell_effect::charm_monster },
    { "mutate", spell_effect::mutate },
    { "bash", spell_effect::bash },
    { "dash", spell_effect::dash },
    { "banishment", spell_effect::banishment },
    { "revive", spell_effect::revive },
    { "revive_dormant", spell_effect::revive_dormant },
    { "upgrade", spell_effect::upgrade },
    { "guilt", spell_effect::guilt },
    { "remove_effect", spell_effect::remove_effect },
    { "emit", spell_effect::emit },
    { "fungalize", spell_effect::fungalize },
    { "remove_field", spell_effect::remove_field },
    { "effect_on_condition", spell_effect::effect_on_condition },
    { "pickup", spell_effect::pickup },
    { "slime_split", spell_effect::slime_split_on_death },
    { "none", spell_effect::none }
};
} // namespace spell_effect

class spellbook_callback : public uilist_callback
{
    private:
        std::vector<spell_type> spells;
    public:
        void add_spell( const spell_id &sp );
        void refresh( uilist *menu ) override;
        float desired_extra_space_right( ) override;
};

// Utility structure to run area queries over weight map. It uses shortest-path-expanding-tree,
// similar to the ones used in pathfinding. Some spell effects, like area_pull use the final
// tree to determine where to move affected objects.
struct area_expander {
    // A single node for a tree.
    struct node {
        // Expanded position
        tripoint_bub_ms position;
        // Previous position
        tripoint_bub_ms from;
        // Accumulated cost.
        float cost = 0.0f;
    };

    int max_range = -1;
    int max_expand = -1;

    // The area we have visited already.
    std::vector<node> area;

    // Maps coordinate to expanded node.
    std::map<tripoint_bub_ms, int> area_search;

    struct area_node_comparator {
        explicit area_node_comparator( std::vector<area_expander::node> &area ) : area( area ) {
        }

        bool operator()( int a, int b ) const {
            return area[a].cost < area[b].cost;
        }

        std::vector<area_expander::node> &area;
    };

    std::priority_queue<int, std::vector<int>, area_node_comparator> frontier;

    area_expander();
    // Check whether we have already visited this node.
    int contains( const tripoint_bub_ms &pt ) const;

    // Adds node to a search tree. Returns true if new node is allocated.
    bool enqueue( const tripoint_bub_ms &from, const tripoint_bub_ms &to, float cost );

    // Run wave propagation
    int run( const tripoint_bub_ms &center );

    // Sort nodes by its cost.
    void sort_ascending();

    void sort_descending();
};

class spell_migration
{
    public:
        spell_id id_old;
        std::optional<spell_id> id_new;

        static void load( const JsonObject &jo );

        static void reset();

        static void check();

        static const spell_migration *find_migration( const spell_id &original );
};

#endif // CATA_SRC_MAGIC_H
